api/userMiscCompensations/{id} (Get)

Get	api/userMiscCompensations/{id}

In This Topic

Resource Path: /sites/{company-id}/api/userMiscCompensations/{id}

Uri: https://secure.ontime360.com/sites/{company-id}/api/userMiscCompensations/{id}

Description

Retrieves a single UserMiscCompensation object assigned to a given identifier.

Parameters

Name	Description	Data Type
id	The unique identifier of any UserMiscCompensation as a Guid.	string

200 Response

The response body is of type UserMiscCompensation.

Returns a comprehensive UserMiscCompensation object.

UserMiscCompensation

Represents a comprehensive UserMiscCompensation record within the OnTime API.

User : string

The unique Guid identifier referencing the User record assigned to this UserMiscCompensation.

ID : string

The unique identifier for this UserMiscCompensation record.

OrderID : string

The unique Guid identifier referencing the Order record assigned to this UserMiscCompensation.

Role : string

The role of the User assigned to the Order for this UserMiscCompensation. Available Values: [None, Dispatcher, Driver]

Description : string

The description containing any notable details or conditions regarding this UserMiscCompensation.

Value : number

The value being given to the User relative to this UserMiscCompensation.

Type : string

The type of compensation being applied to this UserMiscCompensation. Available Values: [None, Money, Time]

Fault Responses

Fault	Description
400	Request was improperly formatted, contained invalid data, or contained incorrect values. See response body for more information.
401	Authorization key is invalid or no longer exists.
403	Authorization key does not have permission to perform this action, or does not have permission to access the requested data. See response body for more information.